<html>
<head>
<meta charset="UTF-8">
</head>
<body>
<h3 id="flexmark-ext-admonition">flexmark-ext-admonition</h3>
<p><strong>flexmark-java extension for <a href="https://squidfunk.github.io/mkdocs-material/extensions/admonition/">Admonition Extension, Material for MkDocs</a> syntax processing</strong></p>
<p>To create block-styled side content. For complete documentation please see the
<a href="https://squidfunk.github.io/mkdocs-material/extensions/admonition/">Admonition Extension, Material for MkDocs</a> documentation. (<em>Personal opinion: Material for
MkDocs is eye-candy. If you have not taken a look at it, you are missing out on a visual
treat.</em>)</p>
<h4 id="block-styled-side-content">Block-Styled Side Content</h4>
<pre><code>!!! qualifier &quot;Optional Title&quot;
    block content 
</code></pre>
<h4 id="no-heading-content">No-Heading Content</h4>
<pre><code>!!! qualifier &quot;&quot;
    block content 
</code></pre>
<h4 id="collapsible-block-styled-side-content">Collapsible Block-Styled Side Content:</h4>
<h5 id="collapsed-by-default">Collapsed by default</h5>
<pre><code>??? qualifier &quot;Optional Title&quot;
    block content 
</code></pre>
<h5 id="open-by-default">Open by default</h5>
<pre><code>???+ qualifier &quot;Optional Title&quot;
     block content 
</code></pre>
<p>SVG images and stylesheet included for default qualifiers. User definable qualifiers can be
added by specifying recognized style qualifiers, their aliases and image mapping.</p>
<p>Qualifiers are used to select the icon and the color of the block.</p>
<table>
<caption>Qualifiers</caption>
<tr><td>
<ul>
  <li>abstract style
    <ul>
      <li><code>abstract</code></li>
      <li><code>summary</code></li>
      <li><code>tldr</code></li>
    </ul>
  </li>
  <li>bug style
    <ul>
      <li><code>bug</code></li>
    </ul>
  </li>
  <li>danger style
    <ul>
      <li><code>danger</code></li>
      <li><code>error</code></li>
    </ul>
  </li>
  <li>example style
    <ul>
      <li><code>example</code></li>
      <li><code>snippet</code></li>
    </ul>
  </li>
  <li>fail style
    <ul>
      <li><code>failure</code></li>
      <li><code>fail</code></li>
      <li><code>missing</code></li>
    </ul>
  </li>
  <li>faq style
    <ul>
      <li><code>question</code></li>
      <li><code>help</code></li>
      <li><code>faq</code></li>
    </ul>
  </li>
  <li>info style
    <ul>
      <li><code>info</code></li>
      <li><code>todo</code></li>
    </ul>
  </li>
  <li>note style
    <ul>
      <li><code>note</code></li>
      <li><code>seealso</code></li>
    </ul>
  </li>
  <li>quote style
    <ul>
      <li><code>quote</code></li>
      <li><code>cite</code></li>
    </ul>
  </li>
  <li>success style
    <ul>
      <li><code>success</code></li>
      <li><code>check</code></li>
      <li><code>done</code></li>
    </ul>
  </li>
  <li>tip style
    <ul>
      <li><code>tip</code></li>
      <li><code>hint</code></li>
      <li><code>important</code></li>
    </ul>
  </li>
  <li>warning style
    <ul>
      <li><code>warning</code></li>
      <li><code>caution</code></li>
      <li><code>attention</code></li>
    </ul>
  </li>
</ul>
</td><td>
<img src="https://github.com/vsch/flexmark-java/raw/master/flexmark-ext-admonition/src/main/javadoc/AdmonitionExample.png" alt="AdmonitionExample.png" height="1000">
</td></tr>
</table>
</body>
</html>
